CP-6005 Ensure vSDK test coverage by mrburke · Pull Request #403 · delphix/virtualization-sdk

mrburke · 2021-10-04T20:04:43Z

Context:

Preparing for the upcoming move to Python 3.8, we need to ensure we have solid test coverage. Fortunately the team has done a great job so far and the only package with a coverage rate < 95% was common.

Name	Statements	Missed	Coverage
setup.py	7	7	0%
dlpx/virtualization/common/_common_classes.py	145	24	83%
dlpx/virtualization/common/exceptions.py	51	27	47%
dlpx/init.py	1	0	100%
dlpx/virtualization/init.py	1	0	100%
dlpx/virtualization/common/init.py	1	0	100%
dlpx/virtualization/common/test_common_classes.py	114	0	100%
TOTAL	320	58	82%

Problem:

The issue mainly lied in dlpx.virtualization.common.exceptions, which had a 47% coverage rate.

Solution:

Added a number of tests targeting the missed areas in common.exceptions.

Testing

New common package coverage:

Name                                                                Stmts   Miss  Cover  
-------------------------------------------------------------------------------------------------
setup.py                                                                7      7     0%   
src/main/python/dlpx/virtualization/common/_common_classes.py         144     12    92% 
src/main/python/dlpx/virtualization/common/exceptions.py               54      4    93%  
src/test/python/dlpx/__init__.py                                        1      0   100%
src/test/python/dlpx/virtualization/__init__.py                         1      0   100%
src/test/python/dlpx/virtualization/common/__init__.py                  1      0   100%
src/test/python/dlpx/virtualization/common/test_common_classes.py     158      0   100%
-------------------------------------------------------------------------------------------------
TOTAL                                                                 366     23    94%

We're now at 94% coverage for this package.

(py2env) ➜  virtualization-sdk git:(cp-6005) ✗ py2env/bin/pytest common/src/test/python/ 
========================================================================================================== test session starts ===========================================================================================================
platform darwin -- Python 2.7.15, pytest-4.6.11, py-1.10.0, pluggy-0.13.1
rootdir: /Users/zachary.burke/virtualization-sdk/common
collected 37 items                                                                                                                                                                                                                       

common/src/test/python/dlpx/virtualization/common/test_common_classes.py .....................................                                                                                                                     [100%]

======================================================================================================= 37 passed in 0.26 seconds ========================================================================================================

common/src/main/python/dlpx/virtualization/common/exceptions.py

* DOC-1074 Document password vault support for VSDK plugins (#347) * Correct Typo in Example, it should be UNIX not WINDOWS (#360) * Add documentation for gRPC message and memory limits #390 (#391) * Fix version number in doc header (#358) (#397) * Update Delphix Engine version required to 6.0.7.0. (#386) (#398) * Update SDK Docs deployment to use a deploy_key (#392) (#399) * CP-6005 Ensure vSDK test coverage (#403) * CP-6006 Futurize vSDK - Stage 1 (#404) * Add support for virtualCleanup decorator (#400) (#405) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Fixes #401 Networking capabilities should be documented (#402) Fixes #401 Networking capabilities should be documented * CP-6009 Add to_str and to_byte helpers (#407) * CP-6621 bump sdk version to 4.0.0 (#409) * CP-6694 Update docs for SDK 4.0.0 (#410) * CP-7022 vSDK 4.0.0 release tasks * Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Update documentation with new gRPC message limits (#415) Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com>

* DOC-1074 Document password vault support for VSDK plugins (delphix#347) * Correct Typo in Example, it should be UNIX not WINDOWS (delphix#360) * Add documentation for gRPC message and memory limits delphix#390 (delphix#391) * Fix version number in doc header (delphix#358) (delphix#397) * Update Delphix Engine version required to 6.0.7.0. (delphix#386) (delphix#398) * Update SDK Docs deployment to use a deploy_key (delphix#392) (delphix#399) * CP-6005 Ensure vSDK test coverage (delphix#403) * CP-6006 Futurize vSDK - Stage 1 (delphix#404) * Add support for virtualCleanup decorator (delphix#400) (delphix#405) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Fixes delphix#401 Networking capabilities should be documented (delphix#402) Fixes delphix#401 Networking capabilities should be documented * CP-6009 Add to_str and to_byte helpers (delphix#407) * CP-6621 bump sdk version to 4.0.0 (delphix#409) * CP-6694 Update docs for SDK 4.0.0 (delphix#410) * CP-7022 vSDK 4.0.0 release tasks * Update VirtualDelete flow diagram to include the virtual.cleanup call. (delphix#414) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Update documentation with new gRPC message limits (delphix#415) Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com>

* DOC-1074 Document password vault support for VSDK plugins (#347) * Correct Typo in Example, it should be UNIX not WINDOWS (#360) * Add documentation for gRPC message and memory limits #390 (#391) * Fix version number in doc header (#358) (#397) * Update Delphix Engine version required to 6.0.7.0. (#386) (#398) * Update SDK Docs deployment to use a deploy_key (#392) (#399) * CP-6005 Ensure vSDK test coverage (#403) * CP-6006 Futurize vSDK - Stage 1 (#404) * Add support for virtualCleanup decorator (#400) (#405) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Fixes #401 Networking capabilities should be documented (#402) Fixes #401 Networking capabilities should be documented * CP-6009 Add to_str and to_byte helpers (#407) * CP-6621 bump sdk version to 4.0.0 (#409) * CP-6694 Update docs for SDK 4.0.0 (#410) * CP-7022 vSDK 4.0.0 release tasks * Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Update documentation with new gRPC message limits (#415) Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com> Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com>

* CP-7022 vSDK 4.0.0 release tasks (#416) * Bumping sdk to 4.0.2 and dvp-api to 1.6.3 due to bad upload of dvp-api 1.6.1 to pypi (#419) * Release (#418) * DOC-1074 Document password vault support for VSDK plugins (#347) * Correct Typo in Example, it should be UNIX not WINDOWS (#360) * Add documentation for gRPC message and memory limits #390 (#391) * Fix version number in doc header (#358) (#397) * Update Delphix Engine version required to 6.0.7.0. (#386) (#398) * Update SDK Docs deployment to use a deploy_key (#392) (#399) * CP-6005 Ensure vSDK test coverage (#403) * CP-6006 Futurize vSDK - Stage 1 (#404) * Add support for virtualCleanup decorator (#400) (#405) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Fixes #401 Networking capabilities should be documented (#402) Fixes #401 Networking capabilities should be documented * CP-6009 Add to_str and to_byte helpers (#407) * CP-6621 bump sdk version to 4.0.0 (#409) * CP-6694 Update docs for SDK 4.0.0 (#410) * CP-7022 vSDK 4.0.0 release tasks * Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Update documentation with new gRPC message limits (#415) Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com> * Release (#418) (#421) * DOC-1074 Document password vault support for VSDK plugins (#347) * Correct Typo in Example, it should be UNIX not WINDOWS (#360) * Add documentation for gRPC message and memory limits #390 (#391) * Fix version number in doc header (#358) (#397) * Update Delphix Engine version required to 6.0.7.0. (#386) (#398) * Update SDK Docs deployment to use a deploy_key (#392) (#399) * CP-6005 Ensure vSDK test coverage (#403) * CP-6006 Futurize vSDK - Stage 1 (#404) * Add support for virtualCleanup decorator (#400) (#405) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Fixes #401 Networking capabilities should be documented (#402) Fixes #401 Networking capabilities should be documented * CP-6009 Add to_str and to_byte helpers (#407) * CP-6621 bump sdk version to 4.0.0 (#409) * CP-6694 Update docs for SDK 4.0.0 (#410) * CP-7022 vSDK 4.0.0 release tasks * Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Update documentation with new gRPC message limits (#415) Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com> Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com> Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com>

mrburke requested review from ankursarin, mothslaw and nhlien93 as code owners October 4, 2021 20:04

nhlien93 approved these changes Oct 5, 2021

View reviewed changes

ravi-cm approved these changes Oct 6, 2021

View reviewed changes

common/src/main/python/dlpx/virtualization/common/exceptions.py Show resolved Hide resolved

CP-6005 Ensure vSDK test coverage

82d2806

mrburke force-pushed the cp-6005 branch from e382d65 to 82d2806 Compare October 6, 2021 16:35

mrburke merged commit f0833f0 into delphix:develop Oct 6, 2021

vimleshmishra mentioned this pull request Mar 16, 2022

4.0.0 post-release tasks - merge release into develop (#425) vimleshmishra/virtualization-sdk#1

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CP-6005 Ensure vSDK test coverage#403

CP-6005 Ensure vSDK test coverage#403
mrburke merged 1 commit intodelphix:developfrom
mrburke:cp-6005

mrburke commented Oct 4, 2021

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Conversation

mrburke commented Oct 4, 2021

Context:

Problem:

Solution:

Testing

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants